home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_vim.idb / usr / freeware / catman / u_man / cat1 / vim.Z / vim
Encoding:
Text File  |  1998-10-28  |  15.2 KB  |  464 lines

  1. /xlv1/freeware/1998.Nov/vim/5.0/vim-5.0.diffbuild/doc
  2.  
  3.  
  4.  
  5.      VVVVIIIIMMMM((((1111))))         UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((1111999999998888 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 11119999))))        VVVVIIIIMMMM((((1111))))
  6.  
  7.  
  8.  
  9.      NNNNAAAAMMMMEEEE
  10.       vim -    Vi IMproved, a programmers text    editor
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.       vvvviiiimmmm [options]    [file ..]
  14.       vvvviiiimmmm [options]    -
  15.       vvvviiiimmmm [options]    -t tag
  16.       vvvviiiimmmm [options]    -q [errorfile]
  17.  
  18.       eeeexxxx
  19.       vvvviiiieeeewwww
  20.       ggggvvvviiiimmmm ggggvvvviiiieeeewwww
  21.       rrrrvvvviiiimmmm rrrrvvvviiiieeeewwww rrrrggggvvvviiiimmmm rrrrggggvvvviiiieeeewwww
  22.  
  23.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  24.       VVVViiiimmmm is a text    editor that is upwards compatible to Vi.  It
  25.       can be used to edit any ASCII    text.  It is especially    useful
  26.       for editing programs.
  27.  
  28.       There    are a lot of enhancements above    Vi: multi level    undo,
  29.       multi    windows    and buffers, syntax highlighting, command line
  30.       editing, filename completion,    on-line    help, visual
  31.       selection, etc..  See    ":help vi_diff"    for a summary of the
  32.       differences between VVVViiiimmmm and Vi.
  33.  
  34.       While    running    VVVViiiimmmm a lot of help can be obtained from the
  35.       on-line help system, with the    ":help"    command.  See the ON-
  36.       LINE HELP section below.
  37.  
  38.       Most often VVVViiiimmmm is started to edit a single file with the
  39.       command
  40.  
  41.            vim file
  42.  
  43.       More generally VVVViiiimmmm is    started    with:
  44.  
  45.            vim [options] [filelist]
  46.  
  47.       If the filelist is missing, the editor will start with an
  48.       empty    buffer.     Otherwise exactly one out of the following
  49.       four may be used to choose one or more files to be edited.
  50.  
  51.       file ..     A    list of    filenames.  The    first one will be the
  52.               current file and read into the buffer.  The
  53.               cursor will be positioned    on the first line of
  54.               the buffer.  You can get to the other files with
  55.               the ":next" command.  To edit a file that    starts
  56.               with a dash, precede the filelist    with "--".
  57.  
  58.       -          The file to edit is read from stdin.  Commands
  59.               are read from stderr, which should be a tty.
  60.  
  61.  
  62.  
  63.  
  64.      Page 1                        (printed 10/20/98)
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.      VVVVIIIIMMMM((((1111))))         UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((1111999999998888 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 11119999))))        VVVVIIIIMMMM((((1111))))
  72.  
  73.  
  74.  
  75.       -t {tag}    The file to edit and the initial cursor position
  76.               depends on a "tag", a sort of goto label.     {tag}
  77.               is looked    up in the tags file, the associated
  78.               file becomes the current file and    the associated
  79.               command is executed.  Mostly this    is used    for C
  80.               programs,    in which case {tag} could be a
  81.               function name.  The effect is that the file
  82.               containing that function becomes the current
  83.               file and the cursor is positioned    on the start
  84.               of the function.    See ":help tag_commands".
  85.  
  86.       -q [errorfile]
  87.               Start in quickFix    mode.  The file    [errorfile] is
  88.               read and the first error is displayed.  If
  89.               [errorfile] is omitted, the filename is obtained
  90.               from the 'errorfile' option (defaults to
  91.               "AztecC.Err" for the Amiga, "errors.vim" on
  92.               other systems).  Further errors can be jumped to
  93.               with the ":cn" command.  See ":help quickfix".
  94.  
  95.       VVVViiiimmmm behaves differently, depending on    the name of the
  96.       command (the executable may still be the same    file).
  97.  
  98.       vim        The    "normal" way, everything is default.
  99.  
  100.       ex        Start in Ex    mode.  Go to Normal mode with the
  101.             ":vi" command.  Can    also be    done with the "-e"
  102.             argument.
  103.  
  104.       view        Start in read-only mode.  You will be protected
  105.             from writing the files.  Can also be done with the
  106.             "-R" argument.
  107.  
  108.       gvim gview
  109.             The    GUI version.  Starts a new window.  Can    also
  110.             be done with the "-g" argument.
  111.  
  112.       rvim rview rgvim rgview
  113.             Like the above, but    with restrictions.  It will
  114.             not    be possible to start shell commands, or
  115.             suspend VVVViiiimmmm.... Can also be done with the "-Z"
  116.             argument.
  117.  
  118.      OOOOPPPPTTTTIIIIOOOONNNNSSSS
  119.       The options may be given in any order, before    or after
  120.       filenames.  Options without an argument can be combined
  121.       after    a single dash.
  122.  
  123.       +[num]      For the first file the cursor will be positioned
  124.               on line "num".  If "num" is missing, the cursor
  125.               will be positioned on the    last line.
  126.  
  127.  
  128.  
  129.  
  130.      Page 2                        (printed 10/20/98)
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.      VVVVIIIIMMMM((((1111))))         UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((1111999999998888 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 11119999))))        VVVVIIIIMMMM((((1111))))
  138.  
  139.  
  140.  
  141.       +/{pat}     For the first file the cursor will be positioned
  142.               on the first occurrence of {pat}.     See ":help
  143.               search_pattern" for the available    search
  144.               patterns.
  145.  
  146.       +{command}
  147.  
  148.       -c {command}
  149.               {command}    will be    executed after the first file
  150.               has been read.  {command}    is interpreted as an
  151.               Ex command.  If the {command} contains spaces it
  152.               must be enclosed in double quotes    (this depends
  153.               on the shell that    is used).  Example: Vim    "+set
  154.               si" main.c
  155.               Note: You    can use    up to 10 "+" or    "-c" commands.
  156.  
  157.       -b          Binary mode.  A few options will be set that
  158.               makes it possible    to edit    a binary or executable
  159.               file.
  160.  
  161.       -C          Compatible.  Set the 'compatible'    option.     This
  162.               will make    VVVViiiimmmm behave mostly like Vi, even    though
  163.               a    .vimrc file exists.
  164.  
  165.       -d {device} Open {device} for    use as a terminal.  Only on
  166.               the Amiga.  Example:  "-d    con:20/30/600/150".
  167.  
  168.       -e          Start VVVViiiimmmm    in Ex mode, just like the executable
  169.               was called "ex".
  170.  
  171.       -f          Foreground.  For the GUI version,    VVVViiiimmmm will not
  172.               fork and detach from the shell it    was started
  173.               in.  On the Amiga, VVVViiiimmmm is    not restarted to open
  174.               a    new window.  This option should    be used    when
  175.               VVVViiiimmmm is executed by a program that    will wait for
  176.               the edit session to finish (e.g. mail).  On the
  177.               Amiga the    ":sh" and ":!" commands    will not work.
  178.  
  179.       -F          If VVVViiiimmmm has been compiled with FKMAP support for
  180.               editing right-to-left oriented files and Farsi
  181.               keyboard mapping,    this option starts VVVViiiimmmm in
  182.               Farsi mode, i.e. 'fkmap' and 'rightleft' are
  183.               set.  Otherwise an error message is given    and
  184.               VVVViiiimmmm aborts.
  185.  
  186.       -g          If VVVViiiimmmm has been compiled with GUI    support, this
  187.               option enables the GUI.  If no GUI support was
  188.               compiled in, an error message is given and VVVViiiimmmm
  189.               aborts.
  190.  
  191.       -h          Give a bit of help about the command line
  192.               arguments    and options.  After this VVVViiiimmmm exits.
  193.  
  194.  
  195.  
  196.      Page 3                        (printed 10/20/98)
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.      VVVVIIIIMMMM((((1111))))         UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((1111999999998888 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 11119999))))        VVVVIIIIMMMM((((1111))))
  204.  
  205.  
  206.  
  207.       -H          If VVVViiiimmmm has been compiled with RIGHTLEFT support
  208.               for editing right-to-left    oriented files and
  209.               Hebrew keyboard mapping, this option starts VVVViiiimmmm
  210.               in Hebrew    mode, i.e. 'hkmap' and 'rightleft' are
  211.               set.  Otherwise an error message is given    and
  212.               VVVViiiimmmm aborts.
  213.  
  214.       -i {viminfo}
  215.               When using the viminfo file is enabled, this
  216.               option sets the filename to use, instead of the
  217.               default "~/.viminfo".  This can also be used to
  218.               skip the use of the .viminfo file, by giving the
  219.               name "NONE".
  220.  
  221.       -L          Same as -r.
  222.  
  223.       -l          Lisp mode.  Sets the 'lisp' and 'showmatch'
  224.               options on.
  225.  
  226.       -N          No-compatible mode.  Reset the 'compatible'
  227.               option.  This will make VVVViiiimmmm behave a bit better,
  228.               but less Vi compatible, even though a .vimrc
  229.               file does    not exist.
  230.  
  231.       -n          No swap file will    be used.  Recovery after a
  232.               crash will be impossible.     Handy if you want to
  233.               edit a file on a very slow medium    (e.g. floppy).
  234.               Can also be done with ":set uc=0".  Can be
  235.               undone with ":set    uc=200".
  236.  
  237.       -o[N]          Open N windows.  When N is omitted, open one
  238.               window for each file.
  239.  
  240.       -R          Read-only    mode.  The 'readonly' option will be
  241.               set.  You    can still edit the buffer, but will be
  242.               prevented    from accidently    overwriting a file.
  243.               If you do    want to    overwrite a file, add an
  244.               exclamation mark to the Ex command, as in    ":w!".
  245.               The -R option also implies the -n    option (see
  246.               below).  The 'readonly' option can be reset with
  247.               ":set noro".  See    ":help 'readonly'".
  248.  
  249.       -r          List swap    files, with information    about using
  250.               them for recovery.
  251.  
  252.       -r {file}   Recovery mode.  The swap file is used to recover
  253.               a    crashed    editing    session.  The swap file    is a
  254.               file with    the same filename as the text file
  255.               with ".swp" appended.  See ":help    recovery".
  256.  
  257.       -s          Silent mode.  Only when started as "Ex" or when
  258.               the "-e" option was given    before the "-s"
  259.  
  260.  
  261.  
  262.      Page 4                        (printed 10/20/98)
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.      VVVVIIIIMMMM((((1111))))         UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((1111999999998888 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 11119999))))        VVVVIIIIMMMM((((1111))))
  270.  
  271.  
  272.  
  273.               option.
  274.  
  275.       -s {scriptin}
  276.               The script file {scriptin} is read.  The
  277.               characters in the    file are interpreted as    if you
  278.               had typed    them.  The same    can be done with the
  279.               command ":source!    {scriptin}".  If the end of
  280.               the file is reached before the editor exits,
  281.               further characters are read from the keyboard.
  282.  
  283.       -T {terminal}
  284.               Tells VVVViiiimmmm    the name of the    terminal you are
  285.               using.  Only required when the automatic way
  286.               doesn't work.  Should be a terminal known    to VVVViiiimmmm
  287.               (builtin)    or defined in the termcap or terminfo
  288.               file.
  289.  
  290.       -u {vimrc}  Use the commands in the file {vimrc} for
  291.               initializations.    All the    other initializations
  292.               are skipped.  Use    this to    edit a special kind of
  293.               files.  It can also be used to skip all
  294.               initializations by giving    the name "NONE".  See
  295.               ":help initialization" within vim    for more
  296.               details.
  297.  
  298.       -U {gvimrc} Use the commands in the file {gvimrc} for    GUI
  299.               initializations.    All the    other GUI
  300.               initializations are skipped.  It can also    be
  301.               used to skip all GUI initializations by giving
  302.               the name "NONE".    See ":help gui_init" within
  303.               vim for more details.
  304.  
  305.       -V          Verbose.    Give messages about which files    are
  306.               sourced and for reading and writing a viminfo
  307.               file.
  308.  
  309.       -v          Start VVVViiiimmmm    in Vi mode, just like the executable
  310.               was called "vi".    This only has effect when the
  311.               executable is called "ex".
  312.  
  313.       -w {scriptout}
  314.               All the characters that you type are recorded in
  315.               the file {scriptout}, until you exit VVVViiiimmmm....    This
  316.               is useful    if you want to create a    script file to
  317.               be used with "vim    -s" or ":source!".  If the
  318.               {scriptout} file exists, characters are
  319.               appended.
  320.  
  321.       -W {scriptout}
  322.               Like -w, but an existing file is overwritten.
  323.  
  324.       -x          Filter read and written files through crypt.
  325.  
  326.  
  327.  
  328.      Page 5                        (printed 10/20/98)
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.      VVVVIIIIMMMM((((1111))))         UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((1111999999998888 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 11119999))))        VVVVIIIIMMMM((((1111))))
  336.  
  337.  
  338.  
  339.               Not implemented yet.
  340.  
  341.       -Z          Restricted mode.    Works like the executable
  342.               starts with "r".
  343.  
  344.       --          Denotes the end of the options.  Arguments after
  345.               this will    be handled as a    file name.  This can
  346.               be used to edit a    filename that starts with a
  347.               '-'.
  348.  
  349.      OOOONNNN----LLLLIIIINNNNEEEE HHHHEEEELLLLPPPP
  350.       Type ":help" in VVVViiiimmmm to get started.  Type ":help subject" to
  351.       get help on a    specific subject.  For example:    ":help ZZ" to
  352.       get help for the "ZZ"    command.  Use <Tab> and    CTRL-D to
  353.       complete subjects (":help cmdline_completion").  Tags    are
  354.       present to jump from one place to another (sort of hypertext
  355.       links, see ":help").    All documentation files    can be viewed
  356.       in this way, for example ":help syntax.txt".
  357.  
  358.      FFFFIIIILLLLEEEESSSS
  359.       /usr/local/lib/vim/doc/*.txt
  360.              The VVVViiiimmmm documentation files.  Use ":help
  361.              doc-file-list"    to get the complete list.
  362.  
  363.       /usr/local/lib/vim/doc/tags
  364.              The tags file used for    finding    information in
  365.              the documentation files.
  366.  
  367.       /usr/local/lib/vim/vimrc
  368.              System    wide VVVViiiimmmm initializations.
  369.  
  370.       /usr/local/lib/vim/gvimrc
  371.              System    wide gvim initializations.
  372.  
  373.       /usr/local/lib/vim/menu.vim
  374.              System    wide menu initializations for gvim.
  375.  
  376.       /usr/local/lib/vim/syntax/syntax.vim
  377.              System    wide syntax initializations.
  378.  
  379.       /usr/local/lib/vim/syntax/*.vim
  380.              Syntax    files for various languages.
  381.  
  382.       For recent info read the VIM home page:
  383.       <URL:http://www.vim.org/>
  384.  
  385.      AAAAUUUUTTTTHHHHOOOORRRR
  386.       Most of VVVViiiimmmm was made by Bram Moolenaar, with a lot of    help
  387.       from others.    See ":help credits".
  388.       VVVViiiimmmm is based on Stevie, worked on by:    Tim Thompson, Tony
  389.       Andrews and G.R. (Fred) Walter.  Although hardly any of the
  390.       original code    remains.
  391.  
  392.  
  393.  
  394.      Page 6                        (printed 10/20/98)
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.      VVVVIIIIMMMM((((1111))))         UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((1111999999998888 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 11119999))))        VVVVIIIIMMMM((((1111))))
  402.  
  403.  
  404.  
  405.      BBBBUUUUGGGGSSSS
  406.       Probably.  See the "todo" file that comes with the
  407.       distribution.
  408.  
  409.       Note that a number of    things that may    be regarded as bugs by
  410.       some,    are in fact caused by a    too-faithful reproduction of
  411.       Vi's behaviour.  Other people    may think other    things are
  412.       bugs "because    Vi does    it differently".  Those    people should
  413.       take a closer    look at    the vi_diff.txt    file (or type :help
  414.       vi_diff.txt when in Vim).  Also have a look at the
  415.       'compatible' option.
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.      Page 7                        (printed 10/20/98)
  461.  
  462.  
  463.  
  464.